package ru.emms.codemeter.metrics.calculators;

import com.intellij.psi.PsiFile;

import java.util.Collection;

/**
 * Created by IntelliJ IDEA.
 * User: nastya.kuz
 * Date: 02.08.2010
 * Time: 14:04:06
 *
 * Интерфейс, который реализуют все классы, вычисляющие метрики
 */
public interface MetricCalculator {

    /**
     * @param sources исходники, по которым считается метрика
     * @return возвращает значение метрики
     */
    public Long calculate(Collection<PsiFile> sources);

    /**
     * Метод возвращает текстовое представление метрики - ее имя.
     *
     * @return имя метрики
     */
    String toString();
}
